Skip to content

Add troubleshooting note for ProofKit 2.04 add-on issue#265

Merged
toddgeist merged 1 commit into
mainfrom
add-troubleshooting-doc
May 15, 2026
Merged

Add troubleshooting note for ProofKit 2.04 add-on issue#265
toddgeist merged 1 commit into
mainfrom
add-troubleshooting-doc

Conversation

@toddgeist
Copy link
Copy Markdown
Contributor

@toddgeist toddgeist commented May 15, 2026

Summary

  • Adds troubleshooting section to AI docs covering the FileMaker access privileges warning that can appear with the ProofKit 2.04 add-on
  • Includes screenshot (filemaker-access-privileges-warning.png) illustrating the dialog
  • Gates PostHog analytics to production only (local-dev fix in instrumentation-client.ts and analytics.ts)
  • Fixes logo dimensions in docs layout config

Test plan

  • Verify troubleshooting page renders correctly at /docs/ai/troubleshooting
  • Confirm screenshot displays in the new troubleshooting section
  • Confirm PostHog is not initialized in local dev (check NODE_ENV !== 'production' guard)
  • Confirm docs logo renders at correct dimensions

Summary by CodeRabbit

  • Documentation

    • Added troubleshooting guide for FileMaker access privilege warnings, including support contact information and visual guidance.
  • Style

    • Updated logo display sizing in documentation site layout.
  • Chores

    • Analytics initialization now limited to production environments.

Review Change Stack

…to prod; fix logo dimensions

- docs/ai/troubleshooting.mdx: new section for "access privileges damaged" warning from ProofKit 2.04 add-on install bug
- screenshots/ai/filemaker-access-privileges-warning.png: screenshot for new section
- instrumentation-client.ts / analytics.ts: gate PostHog init to production to suppress local-dev console errors
- layout.config.tsx: correct logo intrinsic dimensions (96×150 → 2585×804)
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 15, 2026

⚠️ No Changeset found

Latest commit: ca0973a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown

vercel Bot commented May 15, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
proofkit-docs Ready Ready Preview, Comment May 15, 2026 3:37pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

📝 Walkthrough

Walkthrough

This PR restricts PostHog analytics to production environments, updates documentation with a FileMaker troubleshooting guide, and adjusts logo image dimensions in the docs app's navigation header.

Changes

Docs App Configuration and Content Updates

Layer / File(s) Summary
PostHog production-only initialization and tracking gating
apps/docs/src/instrumentation-client.ts, apps/docs/src/lib/analytics.ts
PostHog initialization is gated behind an isPostHogEnabled flag that requires both production environment and a valid project token. The development debug callback is removed, and analytics event tracking inherits the same production-only condition.
Logo dimensions and FileMaker troubleshooting guide
apps/docs/src/app/layout.config.tsx, apps/docs/content/docs/ai/troubleshooting.mdx
Navigation branding logo <Image> dimensions are updated for light and dark variants, and a new troubleshooting section is added documenting the FileMaker access privilege warning that affected ProofKit 2.04 installations, with support contact details.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • proofsh/proofkit#254: Both PRs modify the ProofKit logo image height and width props in baseOptions.nav.title.
  • proofsh/proofkit#240: Both PRs modify PostHog analytics initialization and isPostHogEnabled gating in apps/docs/src/instrumentation-client.ts and apps/docs/src/lib/analytics.ts.
  • proofsh/proofkit#252: Both PRs adjust PostHog initialization conditions and isPostHogEnabled logic in the docs app's analytics modules.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly reflects the main documentation change: adding a troubleshooting note for a ProofKit 2.04 add-on issue. While the PR also includes PostHog configuration and logo dimension fixes, these are secondary changes compared to the primary objective of documenting the FileMaker access privileges warning.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-troubleshooting-doc

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
apps/docs/src/app/layout.config.tsx (1)

17-19: ⚡ Quick win

Extract repeated logo dimensions into named constants.

Line 17, Line 19, Line 24, and Line 26 duplicate intrinsic dimension literals (804, 2585). A shared constant pair keeps the light/dark variants in sync and makes intent clearer.

♻️ Proposed refactor
+const LOGO_INTRINSIC_WIDTH = 2585;
+const LOGO_INTRINSIC_HEIGHT = 804;
+
 export const baseOptions = {
   nav: {
     title: (
       <>
         <Image
           alt="ProofKit"
           className="block h-auto w-[96px] dark:hidden"
-          height={804}
+          height={LOGO_INTRINSIC_HEIGHT}
           src="/logo-horiz-light.svg"
-          width={2585}
+          width={LOGO_INTRINSIC_WIDTH}
         />
         <Image
           alt="ProofKit"
           className="hidden h-auto w-[96px] dark:block"
-          height={804}
+          height={LOGO_INTRINSIC_HEIGHT}
           src="/logo-horiz-dark.svg"
-          width={2585}
+          width={LOGO_INTRINSIC_WIDTH}
         />
       </>
     ),

As per coding guidelines, **/*.{js,jsx,ts,tsx}: Use meaningful variable names instead of magic numbers - extract constants with descriptive names.

Also applies to: 24-26

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@apps/docs/src/app/layout.config.tsx` around lines 17 - 19, Extract the
repeated intrinsic dimensions into descriptive constants (e.g., LOGO_WIDTH and
LOGO_HEIGHT) and replace the magic numbers used for both logo variants (the
Image/Image-like props with src "/logo-horiz-light.svg" and
"/logo-horiz-dark.svg") so both the light and dark logo usages reference the
same constants; update any imports/exports or nearby scope to declare these
constants near the top of the module (layout.config.tsx) so the height and width
props use LOGO_HEIGHT and LOGO_WIDTH instead of 804 and 2585.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@apps/docs/src/app/layout.config.tsx`:
- Around line 17-19: Extract the repeated intrinsic dimensions into descriptive
constants (e.g., LOGO_WIDTH and LOGO_HEIGHT) and replace the magic numbers used
for both logo variants (the Image/Image-like props with src
"/logo-horiz-light.svg" and "/logo-horiz-dark.svg") so both the light and dark
logo usages reference the same constants; update any imports/exports or nearby
scope to declare these constants near the top of the module (layout.config.tsx)
so the height and width props use LOGO_HEIGHT and LOGO_WIDTH instead of 804 and
2585.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f10f7f9c-b544-4ee5-84b4-35f2136b1e7c

📥 Commits

Reviewing files that changed from the base of the PR and between bd9a17f and ca0973a.

⛔ Files ignored due to path filters (1)
  • apps/docs/public/screenshots/ai/filemaker-access-privileges-warning.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • apps/docs/content/docs/ai/troubleshooting.mdx
  • apps/docs/src/app/layout.config.tsx
  • apps/docs/src/instrumentation-client.ts
  • apps/docs/src/lib/analytics.ts

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 15, 2026

Open in StackBlitz

@proofkit/better-auth

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/better-auth@265

@proofkit/cli

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/cli@265

create-proofkit

pnpm add https://pkg.pr.new/proofsh/proofkit/create-proofkit@265

@proofkit/fmdapi

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/fmdapi@265

@proofkit/fmodata

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/fmodata@265

@proofkit/typegen

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/typegen@265

@proofkit/webviewer

pnpm add https://pkg.pr.new/proofsh/proofkit/@proofkit/webviewer@265

commit: ca0973a

@toddgeist toddgeist merged commit 6ee30f5 into main May 15, 2026
20 checks passed
@toddgeist toddgeist deleted the add-troubleshooting-doc branch May 15, 2026 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant